Fix inconsistent highlight blocks. by tomasz-rozanski · Pull Request #62951 · rust-lang/rust

tomasz-rozanski · 2019-07-24T19:44:17Z

shepmaster · 2019-07-24T22:52:04Z

I apologize; I wasn't very clear in the other issue. I think that only the Unicode properties/categories should be in code blocks. This documentation uses single quotes / apostrophes (') as a quoting mechanism, emphasizing a specific term. That's a valid usage.

I'll attempt to comment with the lines that should not be changed.

shepmaster

It was easier to mark the ones to keep, except a few places where I wanted to be extra precise.

shepmaster · 2019-07-24T22:53:11Z

src/libcore/char/methods.rs

    }

-    /// Returns `true` if this `char` satisfies the 'XID_Start' Unicode property, and false
+    /// Returns `true` if this `char` satisfies the `XID_Start` Unicode property, and false


I think it's clearer when reading the documentation to highlight this with backticks and it does refer to something which is code-like. At least if not with backticks it would be good to use 'XID_Start' to highlight more.

"Keep" means "keep the change to backticks".

shepmaster · 2019-07-24T22:53:16Z

src/libcore/char/methods.rs

    /// otherwise.
    ///
-    /// 'XID_Start' is a Unicode Derived Property specified in
+    /// `XID_Start` is a Unicode Derived Property specified in


shepmaster · 2019-07-24T22:53:26Z

src/libcore/char/methods.rs

    }

-    /// Returns `true` if this `char` satisfies the 'XID_Continue' Unicode property, and false
+    /// Returns `true` if this `char` satisfies the `XID_Continue` Unicode property, and false


shepmaster · 2019-07-24T22:53:31Z

src/libcore/char/methods.rs

    /// otherwise.
    ///
-    /// 'XID_Continue' is a Unicode Derived Property specified in
+    /// `XID_Continue` is a Unicode Derived Property specified in


shepmaster · 2019-07-24T22:53:36Z

src/libcore/char/methods.rs

+    /// `XID_Continue` is a Unicode Derived Property specified in
    /// [UAX #31](http://unicode.org/reports/tr31/#NFKC_Modifications),
-    /// mostly similar to 'ID_Continue' but modified for closure under NFKx.
+    /// mostly similar to `ID_Continue` but modified for closure under NFKx.


shepmaster · 2019-07-24T22:53:56Z

src/libcore/char/methods.rs

    ///
-    /// 'Alphanumeric'-ness is defined in terms of the Unicode General Categories
-    /// 'Nd', 'Nl', 'No' and the Derived Core Property 'Alphabetic'.
+    /// `Alphanumeric`-ness is defined in terms of the Unicode General Categories


shepmaster · 2019-07-24T22:54:03Z

src/libcore/char/methods.rs

-    /// 'Alphanumeric'-ness is defined in terms of the Unicode General Categories
-    /// 'Nd', 'Nl', 'No' and the Derived Core Property 'Alphabetic'.
+    /// `Alphanumeric`-ness is defined in terms of the Unicode General Categories
+    /// `Nd`, `Nl`, `No` and the Derived Core Property `Alphabetic`.


shepmaster · 2019-07-24T22:54:10Z

src/libcore/char/methods.rs

    ///
-    /// 'Numeric'-ness is defined in terms of the Unicode General Categories
-    /// 'Nd', 'Nl', 'No'.
+    /// `Numeric`-ness is defined in terms of the Unicode General Categories


shepmaster · 2019-07-24T22:54:14Z

src/libcore/char/methods.rs

-    /// 'Numeric'-ness is defined in terms of the Unicode General Categories
-    /// 'Nd', 'Nl', 'No'.
+    /// `Numeric`-ness is defined in terms of the Unicode General Categories
+    /// `Nd`, `Nl`, `No`.


tomasz-rozanski · 2019-07-24T23:57:00Z

So all the changes you didn't quote above, I should also revert?

shepmaster · 2019-07-25T02:31:09Z

So all the changes you didn't quote above, I should also revert?

Yes please. Basically, the things that should be in backticks are the terms specifically referring to a specific Unicode concept.

tomasz-rozanski · 2019-07-25T09:51:25Z

I think I nailed it this time. Fingers crossed.

Centril · 2019-07-25T09:54:10Z

Merge remote-tracking branch 'upstream/master'

Can you please squash the commits? We prefer not to have merge commits in our history.

tomasz-rozanski · 2019-07-25T11:42:43Z

Merge remote-tracking branch 'upstream/master'

Can you please squash the commits? We prefer not to have merge commits in our history.

I'm sorry, but it seems that I can't do this anymore. I tried to rebase my local repository, but with no success. I also couldn't find that kind of option on GitHub.

I'm pretty new to Git, so maybe I'm missing something obvious.

Centril · 2019-07-25T11:47:47Z

@Rosto75 Can you try git rebase -i origin/master and then use "fixup" on the 2nd and 3rd commits? Once you've done that you can git push --force-with-lease to push the changes.

tomasz-rozanski · 2019-07-25T12:33:52Z

@Rosto75 Can you try git rebase -i origin/master and then use "fixup" on the 2nd and 3rd commits? Once you've done that you can git push --force-with-lease to push the changes.

After calling git rebase the todo-list file contained only noop. I tried to populate it manually, by putting:

pick ab2ff17b0bad3a9409b51c2c1ed44abe183b5e64
fixup 4c501d19e598c9e44177184bf9c754e7096206bb

and then tried with squash:

pick ab2ff17b0bad3a9409b51c2c1ed44abe183b5e64
squash 4c501d19e598c9e44177184bf9c754e7096206bb

No visible effects, after pushing it.

In the meantime, I managed to create an extra, empty commit, so it's even a bigger mess now. Maybe I should start from scratch.

tomasz-rozanski · 2019-07-25T16:01:31Z

Third time's a charm #62977
🤞

Fix inconsistent highlight blocks.

e94e358

rust-highfive assigned shepmaster Jul 24, 2019

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 24, 2019

tomasz-rozanski mentioned this pull request Jul 24, 2019

Couple of small documentation fixes. #62720

Closed

shepmaster reviewed Jul 24, 2019

View reviewed changes

tomasz-rozanski added 2 commits July 25, 2019 11:41

Merge remote-tracking branch 'upstream/master'

4c501d1

Further refine highlight fix.

ab2ff17

Refine highlight blocks fix.

3d37cf8

tomasz-rozanski closed this Jul 25, 2019

Uh oh!

Conversation

tomasz-rozanski commented Jul 24, 2019

Uh oh!

shepmaster commented Jul 24, 2019

Uh oh!

shepmaster left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tomasz-rozanski commented Jul 24, 2019

Uh oh!

shepmaster commented Jul 25, 2019

Uh oh!

tomasz-rozanski commented Jul 25, 2019

Uh oh!

Centril commented Jul 25, 2019

Uh oh!

tomasz-rozanski commented Jul 25, 2019

Uh oh!

Centril commented Jul 25, 2019

Uh oh!

tomasz-rozanski commented Jul 25, 2019

Uh oh!

tomasz-rozanski commented Jul 25, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants